// HTMLParser Library - A java-based parser for HTML
// http://htmlparser.org
// Copyright (C) 2006 Derrick Oswald
//
// Revision Control Information
//
// $URL: https://svn.sourceforge.net/svnroot/htmlparser/trunk/parser/src/main/java/org/htmlparser/filters/OrFilter.java $
// $Author: derrickoswald $
// $Date: 2006-09-16 10:44:17 -0400 (Sat, 16 Sep 2006) $
// $Revision: 4 $
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Common Public License; either
// version 1.0 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// Common Public License for more details.
//
// You should have received a copy of the Common Public License
// along with this library; if not, the license is available from
// the Open Source Initiative (OSI) website:
//   http://opensource.org/licenses/cpl1.0.php

package org.htmlparser.filters;

import org.htmlparser.Node;
import org.htmlparser.NodeFilter;

/**
 * Accepts nodes matching any of its predicates filters (OR operation).
 */
public class OrFilter implements NodeFilter {
	/**
	 * The predicates that are to be or'ed together;
	 */
	protected NodeFilter[] mPredicates;

	/**
	 * Creates a new instance of an OrFilter. With no predicates, this would
	 * always answer <code>false</code> to {@link #accept}.
	 * 
	 * @see #setPredicates
	 */
	public OrFilter() {
		setPredicates(null);
	}

	/**
	 * Creates an OrFilter that accepts nodes acceptable to either filter.
	 * 
	 * @param left
	 *            One filter.
	 * @param right
	 *            The other filter.
	 */
	public OrFilter(NodeFilter left, NodeFilter right) {
		NodeFilter[] predicates;

		predicates = new NodeFilter[2];
		predicates[0] = left;
		predicates[1] = right;
		setPredicates(predicates);
	}

	/**
	 * Creates an OrFilter that accepts nodes acceptable to any of the given
	 * filters.
	 * 
	 * @param predicates
	 *            The list of filters.
	 */
	public OrFilter(NodeFilter[] predicates) {
		setPredicates(predicates);
	}

	/**
	 * Get the predicates used by this OrFilter.
	 * 
	 * @return The predicates currently in use.
	 */
	public NodeFilter[] getPredicates() {
		return (mPredicates);
	}

	/**
	 * Set the predicates for this OrFilter.
	 * 
	 * @param predicates
	 *            The list of predidcates to use in {@link #accept}.
	 */
	public void setPredicates(NodeFilter[] predicates) {
		if (null == predicates)
			predicates = new NodeFilter[0];
		mPredicates = predicates;
	}

	//
	// NodeFilter interface
	//

	/**
	 * Accept nodes that are acceptable to any of its predicate filters.
	 * 
	 * @param node
	 *            The node to check.
	 * @return <code>true</code> if any of the predicate filters find the node
	 *         is acceptable, <code>false</code> otherwise.
	 */
	public boolean accept(Node node) {
		boolean ret = false;
		for (int i = 0; !ret && (i < mPredicates.length); i++)
			if (mPredicates[i].accept(node))
				ret = true;
		return (ret);
	}
}
